home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / batchut / xset402.zip / XSET.DOC < prev    next >
Text File  |  1994-03-29  |  53KB  |  1,344 lines
  1.     
  2.                ╔═════════════════════════════════════════════╗
  3.                ║     XSET 4.02 : Extended SET Instruction    ║░░
  4.                ║                                             ║░░
  5.                ║       (C) 1991-1994 Stern Marc              ║░░
  6.                ╚═════════════════════════════════════════════╝░░
  7.                 ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  8.  
  9.  
  10.     Everything you always wanted to put in an environment  variable  but
  11.     were afraid to ask DOS for . . . 
  12.  
  13.         XSET: The easy way to write efficient batch files.
  14.  
  15.     XSET allows you to put EVERYTHING you want  in  a  variable  of  the
  16.     current DOS environment and use it as if you assigned it the value  with
  17.     the standard DOS command 'SET'. You will be able to write very efficient
  18.     batch files including string manipulation, calculation, ...
  19.  
  20.     XSET is the most powerful environment variables manipulation program
  21.     you ever saw. It also has a very easy and intuitive user interface (very
  22.     close to the DOS 'SET' command). It is not a  resident  program;  it  so
  23.     cannot interfere with any of your other applications.
  24.  
  25.     XSET is fully compatible with MS-DOS (from 3.30), DR-DOS, NDOS & 4DOS.
  26.  
  27.  
  28.     XSET has seven major features:
  29.     ═════════════════════════════
  30.  
  31.      - XSET permits  to  catch  the  output  of  any  command  (internal  or
  32.        external) or program and put it into an environment variable.
  33.  
  34.      - XSET has built-in commands to modify the output of  a  program  or  a
  35.        string given on the command-line (extract a part of a string, ...)
  36.  
  37.      - XSET has a built-in full  floating-point  calculation  functionality:
  38.        You can program incremental loops, input  a  calculation  string  and
  39.        output the resulting number, ...
  40.  
  41.      - XSET can manage variable contents of more than 128  characters  (your
  42.        path can now be as long as you want).
  43.  
  44.      - XSET has other built-in commands to give you access  to  some  system
  45.        data (date, time, ...)
  46.                   
  47.      - XSET has built-in commands to clear  all  environment  or  restore  a
  48.        previously saved one.
  49.                 
  50.      - XSET gives you  access  to  high-level  user  interface  input/output
  51.        (line-editing, colors, windows, boxes, ...).
  52.  
  53.  
  54.      More than sixty commands to do all what you need.
  55.  
  56.  
  57.                                                                     Page 1
  58.  
  59.                        ╔═════════════════════════════╗
  60.                        ║      Table of contents      ║░░
  61.                        ╚═════════════════════════════╝░░
  62.                         ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  63.       
  64.  
  65.     The Shareware concept .................................... Page 2
  66.  
  67.     How to use XSET .......................................... Page 3
  68.  
  69.     Examples of use .......................................... Page 4
  70.  
  71.     Syntax explanation ....................................... Page 7
  72.  
  73.     Input explanation ........................................ Page 7
  74.  
  75.     Options and commands description ......................... Page 8
  76.       Input related flags .................................... Page 8
  77.       Prompt related flags ................................... Page 9
  78.       String related flags ................................... Page 10
  79.       Other flags ............................................ Page 11
  80.       Order of execution of /options ......................... Page 13
  81.       Input commands ......................................... Page 14
  82.       Date & time commands ................................... Page 15
  83.       Disk & file commands ................................... Page 16
  84.       Other commands ......................................... Page 19
  85.       Special flags .......................................... Page 20
  86.  
  87.     XSET & XSET_MSG variables ................................ Page 21
  88.  
  89.     Installation ............................................. Page 22
  90.  
  91.     Problems ................................................. Page 22
  92.     
  93.     Batch file programming: Hints & tips ..................... Page 24
  94.  
  95.     Additional information - How to contact the author ....... Page 25
  96.  
  97.     Appendix: E-mail address from other sites ................ Page 25
  98.  
  99.  
  100.                                                                     Page 2
  101.  
  102.                        ╔═════════════════════════════╗
  103.                        ║    The Shareware concept    ║░░
  104.                        ╚═════════════════════════════╝░░
  105.                         ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  106.  
  107.  
  108.     This package is Shareware.
  109.  
  110.     That means that you may try it for evaluation and, if you like  it,  you
  111.     should  consider  to  pay   the   registration   fee   (see   the   file
  112.     'REGISTER.HOW'). You will then become a  registered  user  and  so  have
  113.     access to free support, free correction of acknowledged  bugs  and  free
  114.     upgrades.
  115.  
  116.     Shareware also mean that you may distribute this package everywhere  and
  117.     to everybody you want, providing that you always distribute the complete
  118.     package. If you have access to any BBS, FTP server, E-mail server or any
  119.     other kind of software distribution, feel free to share  it  with  other
  120.     people; this may be useful for them and the more people  will  use  (and
  121.     register) a shareware program, the more stable it will be and  the  more
  122.     functionalities could be added.
  123.  
  124.  
  125.     Warning:   If you paid to get this package (e.g., it  was  onto a floppy
  126.     ───────    with other programs, you downloaded it from a BBS), you  only
  127.                paid for the physical support (the floppy,  the  transmission
  128.                fee, ...); this does not replace the registration fee.
  129.  
  130.  
  131.     Note to software distributors:
  132.     ─────────────────────────────
  133.  
  134.          Nobody is allowed to make any  benefit  by  distributing  the  XSET
  135.          package. Only regular distribution fees are allowed (price  of  the
  136.          floppy, of the network connection, ...).
  137.  
  138.  
  139.  
  140.                                                                     Page 3
  141.  
  142.     How to use XSET:
  143.     ═══════════════
  144.  
  145.     XSET will always  assign  what  you  tell  it  into  a  DOS  environment
  146.     variable. The main goals of XSET are: 
  147.  
  148.       - to ask a question to the user (through the keyboard),
  149.       - to catch the output of a program or a command,
  150.       - to get pieces of information like current date and  time,  timestamp
  151.         or size of a file, ...
  152.       - to modify a string (contained in another variable, in  a  parameter,
  153.         ...) like changing it to lower-/upper-case, performing a  search  on
  154.         it,  calculating  the   result   of   a   mathematical   expression,
  155.         substituting a sub-string by another or extracting a part of it,
  156.       - to handle variables longer than 128 characters.
  157.  
  158.  
  159.     There are four ways to use XSET.
  160.  
  161.     1. Like the normal DOS 'SET' command:
  162.        XSET myvar="This is a test string"
  163.  
  164.     2. To get an input from the user:
  165.        XSET answer
  166.  
  167.     3. To catch the output of a program or a command:
  168.        dir c:\programs\myprog.c | XSET myvar
  169.  
  170.     4. To get various system or environment information:
  171.        XSET myvar TIME
  172.  
  173.     Furthermore, to attain a high level of functionality  you  may  add,  to
  174.     each of the above syntaxs, several option flags to  modify  the  default
  175.     behavior of XSET (for example /UPPER to translate into upper-cases, ...).
  176.  
  177.  
  178.       Syntax:     XSET [/OPTIONS...]  <dosvar>
  179.       ──────      read a string from standard input
  180.  
  181.                   XSET [/OPTIONS...]  <dosvar>="string"
  182.                   equivalent to the DOS command 'SET'
  183.  
  184.                   XSET [/OPTIONS...]  <dosvar>  COMMAND  [arguments ...]
  185.     
  186.  
  187.           ╔══════════════════════════════════════════════════════╗
  188.           ║    Type XSET /? to get the full description          ║░░
  189.           ║    of all functionalities (parameters and effects).  ║░░
  190.           ╚══════════════════════════════════════════════════════╝░░
  191.             ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░